<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8" />
    <meta name="robots" content="index, follow, all" />
    <title>Imagine\Factory\ClassFactoryInterface | Imagine API v1.2.5-dev</title>

            <link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
        <link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
        <link rel="stylesheet" type="text/css" href="../../css/sami.css">
        <script src="../../js/jquery-1.11.1.min.js"></script>
        <script src="../../js/bootstrap.min.js"></script>
        <script src="../../js/typeahead.min.js"></script>
        <script src="../../sami.js"></script>
        <meta name="MobileOptimized" content="width">
        <meta name="HandheldFriendly" content="true">
        <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
    
    
    </head>

    <body id="class" data-name="class:Imagine_Factory_ClassFactoryInterface" data-root-path="../../">
            <div id="content">
        <div id="left-column">
                <div id="control-panel">
                <script>
            $('option[data-version="'+window.projectVersion+'"]').prop('selected', true);
        </script>
        <form id="search-form" action="../../search.html" method="GET">
            <span class="glyphicon glyphicon-search"></span>
            <input name="search"
                   class="typeahead form-control"
                   type="search"
                   placeholder="Search">
        </form>
    </div>

                <div id="api-tree"></div>

        </div>
        <div id="right-column">
                <nav id="site-nav" class="navbar navbar-default" role="navigation">
        <div class="container-fluid">
            <div class="navbar-header">
                <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
                    <span class="sr-only">Toggle navigation</span>
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                    <span class="icon-bar"></span>
                </button>
                <a class="navbar-brand" href="../../index.html">Imagine API v1.2.5-dev</a>
            </div>
            <div class="collapse navbar-collapse" id="navbar-elements">
                <ul class="nav navbar-nav">
                    <li><a href="../../classes.html">Classes</a></li>
                                            <li><a href="../../namespaces.html">Namespaces</a></li>
                                        <li><a href="../../interfaces.html">Interfaces</a></li>
                    <li><a href="../../traits.html">Traits</a></li>
                    <li><a href="../../doc-index.html">Index</a></li>
                    <li><a href="../../search.html">Search</a></li>
                </ul>
            </div>
        </div>
    </nav>

                        <div class="namespace-breadcrumbs">
            <ol class="breadcrumb">
                <li><span class="label label-default">interface</span></li>
                        <li><a href="../../Imagine.html">Imagine</a></li><li class="backslash">\</li><li><a href="../../Imagine/Factory.html">Factory</a></li><li class="backslash">\</li><li>ClassFactoryInterface</li>
            </ol>
        </div>
                <div id="page-content">
                
    <div class="page-header">
        <h1>
            ClassFactoryInterface
                
        </h1>
    </div>

    <p>    interface
    <strong>ClassFactoryInterface</strong>
</p>

        
    

            <div class="description">
            <p>The interface that class factories must implement.</p>                                </div>
    
    
            <h2>Constants</h2>

            <table class="table table-condensed">
                    <tr>
                <td>HANDLE_GD</td>
                <td class="last">
                    <p><em>The handle to be used for the GD manipulation library.</em></p>
                    <p></p>
                </td>
            </tr>
                    <tr>
                <td>HANDLE_GMAGICK</td>
                <td class="last">
                    <p><em>The handle to be used for the Gmagick manipulation library.</em></p>
                    <p></p>
                </td>
            </tr>
                    <tr>
                <td>HANDLE_IMAGICK</td>
                <td class="last">
                    <p><em>The handle to be used for the Imagick manipulation library.</em></p>
                    <p></p>
                </td>
            </tr>
            </table>

    
    
            <h2>Methods</h2>

            <div class="container-fluid underlined">
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/Image/Metadata/MetadataReaderInterface.html"><abbr title="Imagine\Image\Metadata\MetadataReaderInterface">MetadataReaderInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createMetadataReader">createMetadataReader</a>()
        
                                            <p>Create a new instance of a metadata reader.</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/Image/BoxInterface.html"><abbr title="Imagine\Image\BoxInterface">BoxInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createBox">createBox</a>(int $width, int $height)
        
                                            <p>Create new BoxInterface instance.</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/Image/FontInterface.html"><abbr title="Imagine\Image\FontInterface">FontInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createFont">createFont</a>(string $handle, string $file, int $size, <a href="../../Imagine/Image/Palette/Color/ColorInterface.html"><abbr title="Imagine\Image\Palette\Color\ColorInterface">ColorInterface</abbr></a> $color)
        
                                            <p>Create new FontInterface instance.</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/File/LoaderInterface.html"><abbr title="Imagine\File\LoaderInterface">LoaderInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createFileLoader">createFileLoader</a>(string|mixed $path)
        
                                            <p>Create a new instance of a file loader.</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/Image/LayersInterface.html"><abbr title="Imagine\Image\LayersInterface">LayersInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createLayers">createLayers</a>(string $handle, <a href="../../Imagine/Image/ImageInterface.html"><abbr title="Imagine\Image\ImageInterface">ImageInterface</abbr></a> $image, mixed|null $initialKey = null)
        
                                            <p>Crate a new instance of a layers interface.</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/Image/ImageInterface.html"><abbr title="Imagine\Image\ImageInterface">ImageInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createImage">createImage</a>(string $handle, mixed $resource, <a href="../../Imagine/Image/Palette/PaletteInterface.html"><abbr title="Imagine\Image\Palette\PaletteInterface">PaletteInterface</abbr></a> $palette, <a href="../../Imagine/Image/Metadata/MetadataBag.html"><abbr title="Imagine\Image\Metadata\MetadataBag">MetadataBag</abbr></a> $metadata)
        
                                            <p>Create a new ImageInterface instance.</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/Draw/DrawerInterface.html"><abbr title="Imagine\Draw\DrawerInterface">DrawerInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createDrawer">createDrawer</a>(string $handle, mixed $resource)
        
                                            <p>Create a new DrawerInterface instance.</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    <a href="../../Imagine/Effects/EffectsInterface.html"><abbr title="Imagine\Effects\EffectsInterface">EffectsInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_createEffects">createEffects</a>(string $handle, mixed $resource)
        
                                            <p>Create a new EffectsInterface instance.</p>                </div>
                <div class="col-md-2"></div>
            </div>
            </div>


        <h2>Details</h2>

            <div id="method-details">
                    <div class="method-item">
                    <h3 id="method_createMetadataReader">
        <div class="location">at         line 38</div>
        <code>                    <a href="../../Imagine/Image/Metadata/MetadataReaderInterface.html"><abbr title="Imagine\Image\Metadata\MetadataReaderInterface">MetadataReaderInterface</abbr></a>
    <strong>createMetadataReader</strong>()
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Create a new instance of a metadata reader.</p>                                                </div>
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/Image/Metadata/MetadataReaderInterface.html"><abbr title="Imagine\Image\Metadata\MetadataReaderInterface">MetadataReaderInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_createBox">
        <div class="location">at         line 48</div>
        <code>                    <a href="../../Imagine/Image/BoxInterface.html"><abbr title="Imagine\Image\BoxInterface">BoxInterface</abbr></a>
    <strong>createBox</strong>(int $width, int $height)
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Create new BoxInterface instance.</p>                                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>int</td>
                <td>$width</td>
                <td>The box width</td>
            </tr>
                    <tr>
                <td>int</td>
                <td>$height</td>
                <td>The box height</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/Image/BoxInterface.html"><abbr title="Imagine\Image\BoxInterface">BoxInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_createFont">
        <div class="location">at         line 60</div>
        <code>                    <a href="../../Imagine/Image/FontInterface.html"><abbr title="Imagine\Image\FontInterface">FontInterface</abbr></a>
    <strong>createFont</strong>(string $handle, string $file, int $size, <a href="../../Imagine/Image/Palette/Color/ColorInterface.html"><abbr title="Imagine\Image\Palette\Color\ColorInterface">ColorInterface</abbr></a> $color)
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Create new FontInterface instance.</p>                                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>string</td>
                <td>$handle</td>
                <td>The handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).</td>
            </tr>
                    <tr>
                <td>string</td>
                <td>$file</td>
                <td></td>
            </tr>
                    <tr>
                <td>int</td>
                <td>$size</td>
                <td>the font size in points (e.g. 10pt means 10)</td>
            </tr>
                    <tr>
                <td><a href="../../Imagine/Image/Palette/Color/ColorInterface.html"><abbr title="Imagine\Image\Palette\Color\ColorInterface">ColorInterface</abbr></a></td>
                <td>$color</td>
                <td></td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/Image/FontInterface.html"><abbr title="Imagine\Image\FontInterface">FontInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_createFileLoader">
        <div class="location">at         line 69</div>
        <code>                    <a href="../../Imagine/File/LoaderInterface.html"><abbr title="Imagine\File\LoaderInterface">LoaderInterface</abbr></a>
    <strong>createFileLoader</strong>(string|mixed $path)
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Create a new instance of a file loader.</p>                                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>string|mixed</td>
                <td>$path</td>
                <td></td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/File/LoaderInterface.html"><abbr title="Imagine\File\LoaderInterface">LoaderInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_createLayers">
        <div class="location">at         line 80</div>
        <code>                    <a href="../../Imagine/Image/LayersInterface.html"><abbr title="Imagine\Image\LayersInterface">LayersInterface</abbr></a>
    <strong>createLayers</strong>(string $handle, <a href="../../Imagine/Image/ImageInterface.html"><abbr title="Imagine\Image\ImageInterface">ImageInterface</abbr></a> $image, mixed|null $initialKey = null)
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Crate a new instance of a layers interface.</p>                                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>string</td>
                <td>$handle</td>
                <td>The handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).</td>
            </tr>
                    <tr>
                <td><a href="../../Imagine/Image/ImageInterface.html"><abbr title="Imagine\Image\ImageInterface">ImageInterface</abbr></a></td>
                <td>$image</td>
                <td></td>
            </tr>
                    <tr>
                <td>mixed|null</td>
                <td>$initialKey</td>
                <td>the key of the initially selected layer</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/Image/LayersInterface.html"><abbr title="Imagine\Image\LayersInterface">LayersInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_createImage">
        <div class="location">at         line 92</div>
        <code>                    <a href="../../Imagine/Image/ImageInterface.html"><abbr title="Imagine\Image\ImageInterface">ImageInterface</abbr></a>
    <strong>createImage</strong>(string $handle, mixed $resource, <a href="../../Imagine/Image/Palette/PaletteInterface.html"><abbr title="Imagine\Image\Palette\PaletteInterface">PaletteInterface</abbr></a> $palette, <a href="../../Imagine/Image/Metadata/MetadataBag.html"><abbr title="Imagine\Image\Metadata\MetadataBag">MetadataBag</abbr></a> $metadata)
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Create a new ImageInterface instance.</p>                                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>string</td>
                <td>$handle</td>
                <td>The handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).</td>
            </tr>
                    <tr>
                <td>mixed</td>
                <td>$resource</td>
                <td></td>
            </tr>
                    <tr>
                <td><a href="../../Imagine/Image/Palette/PaletteInterface.html"><abbr title="Imagine\Image\Palette\PaletteInterface">PaletteInterface</abbr></a></td>
                <td>$palette</td>
                <td></td>
            </tr>
                    <tr>
                <td><a href="../../Imagine/Image/Metadata/MetadataBag.html"><abbr title="Imagine\Image\Metadata\MetadataBag">MetadataBag</abbr></a></td>
                <td>$metadata</td>
                <td></td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/Image/ImageInterface.html"><abbr title="Imagine\Image\ImageInterface">ImageInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_createDrawer">
        <div class="location">at         line 102</div>
        <code>                    <a href="../../Imagine/Draw/DrawerInterface.html"><abbr title="Imagine\Draw\DrawerInterface">DrawerInterface</abbr></a>
    <strong>createDrawer</strong>(string $handle, mixed $resource)
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Create a new DrawerInterface instance.</p>                                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>string</td>
                <td>$handle</td>
                <td>The handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).</td>
            </tr>
                    <tr>
                <td>mixed</td>
                <td>$resource</td>
                <td></td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/Draw/DrawerInterface.html"><abbr title="Imagine\Draw\DrawerInterface">DrawerInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_createEffects">
        <div class="location">at         line 112</div>
        <code>                    <a href="../../Imagine/Effects/EffectsInterface.html"><abbr title="Imagine\Effects\EffectsInterface">EffectsInterface</abbr></a>
    <strong>createEffects</strong>(string $handle, mixed $resource)
        </code>
    </h3>
    <div class="details">
            
    

                    <div class="method-description">
                                    <p>Create a new EffectsInterface instance.</p>                                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>string</td>
                <td>$handle</td>
                <td>The handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).</td>
            </tr>
                    <tr>
                <td>mixed</td>
                <td>$resource</td>
                <td></td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td><a href="../../Imagine/Effects/EffectsInterface.html"><abbr title="Imagine\Effects\EffectsInterface">EffectsInterface</abbr></a></td>
            <td></td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
            </div>

    
            </div>
                <div id="footer">
        Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
    </div>

        </div>
    </div>
    </body>

</html>
